<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>ActiveFixture, yii\elasticsearch\ActiveFixture - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w11585" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w11585-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w11585-collapse" class="collapse navbar-collapse"><ul id="w11586" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w11587" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item active" href="#navigation-11584" data-toggle="collapse" data-parent="#navigation">yii\elasticsearch <b class="caret"></b></a><div id="navigation-11584" class="submenu panel-collapse collapse in"><a class="list-group-item" href="./yii-elasticsearch-activedataprovider.html">ActiveDataProvider</a>
<a class="list-group-item active" href="./yii-elasticsearch-activefixture.html">ActiveFixture</a>
<a class="list-group-item" href="./yii-elasticsearch-activequery.html">ActiveQuery</a>
<a class="list-group-item" href="./yii-elasticsearch-activerecord.html">ActiveRecord</a>
<a class="list-group-item" href="./yii-elasticsearch-batchqueryresult.html">BatchQueryResult</a>
<a class="list-group-item" href="./yii-elasticsearch-bulkcommand.html">BulkCommand</a>
<a class="list-group-item" href="./yii-elasticsearch-command.html">Command</a>
<a class="list-group-item" href="./yii-elasticsearch-connection.html">Connection</a>
<a class="list-group-item" href="./yii-elasticsearch-debugaction.html">DebugAction</a>
<a class="list-group-item" href="./yii-elasticsearch-debugpanel.html">DebugPanel</a>
<a class="list-group-item" href="./yii-elasticsearch-exception.html">Exception</a>
<a class="list-group-item" href="./yii-elasticsearch-query.html">Query</a>
<a class="list-group-item" href="./yii-elasticsearch-querybuilder.html">QueryBuilder</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class yii\elasticsearch\ActiveFixture</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
            | <a href="#properties">Properties</a>
                | <a href="#methods">Methods</a>
            </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a> &raquo;
<a href="yii-test-baseactivefixture.html">yii\test\BaseActiveFixture</a> &raquo;
<a href="yii-test-dbfixture.html">yii\test\DbFixture</a> &raquo;
<a href="yii-test-fixture.html">yii\test\Fixture</a> &raquo;
<a href="yii-base-component.html">yii\base\Component</a> &raquo;
<a href="yii-base-object.html">yii\base\Object</a></td></tr>
                <tr><th>Implements</th><td><a href="http://www.php.net/class.arrayaccess">ArrayAccess</a>, <a href="http://www.php.net/class.countable">Countable</a>, <a href="http://www.php.net/class.iteratoraggregate">IteratorAggregate</a>, <a href="yii-base-configurable.html">yii\base\Configurable</a></td></tr>
                    <tr><th>Uses Traits</th><td><a href="yii-base-arrayaccesstrait.html">yii\base\ArrayAccessTrait</a></td></tr>
                            <tr><th>Available since version</th><td>2.0.2</td></tr>
                    <tr>
          <th>Source Code</th>
          <td><a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php">https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php</a></td>
        </tr>
    </table>

<div class="class-description">
    <p><strong>ActiveFixture represents a fixture for testing backed up by an <a href="yii-test-baseactivefixture.html#$modelClass-detail">ActiveRecord class</a> or an elastic search index.</strong></p>
    <p>Either <a href="yii-test-baseactivefixture.html#$modelClass-detail">$modelClass</a> or <a href="yii-elasticsearch-activefixture.html#$index-detail">$index</a> and <a href="yii-elasticsearch-activefixture.html#$type-detail">$type</a> must be set. You should also provide fixture data in the file
specified by <a href="yii-elasticsearch-activefixture.html#$dataFile-detail">$dataFile</a> or overriding <a href="yii-elasticsearch-activefixture.html#getData()-detail">getData()</a> if you want to use code to generate the fixture data.</p>
<p>When the fixture is being loaded, it will first call <a href="yii-elasticsearch-activefixture.html#resetIndex()-detail">resetIndex()</a> to remove any existing data in the index for the <a href="yii-elasticsearch-activefixture.html#$type-detail">$type</a>.
It will then populate the index with the data returned by <a href="yii-elasticsearch-activefixture.html#getData()-detail">getData()</a>.</p>
<p>After the fixture is loaded, you can access the loaded data via the <a href="yii-test-baseactivefixture.html#$data-detail">$data</a> property. If you set <a href="yii-test-baseactivefixture.html#$modelClass-detail">$modelClass</a>,
you will also be able to retrieve an instance of <a href="yii-test-baseactivefixture.html#$modelClass-detail">$modelClass</a> with the populated data via <a href="yii-test-baseactivefixture.html#getModel()-detail">getModel()</a>.</p>

    </div>

<a id="properties"></a>

<div class="summary doc-property">
<h2>Public Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="$behaviors">
        <td><a href="yii-base-component.html#$behaviors-detail">$behaviors</a></td>
        <td><a href="yii-base-behavior.html">yii\base\Behavior</a>[]</td>
        <td>List of behaviors attached to this component</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="$data">
        <td><a href="yii-test-baseactivefixture.html#$data-detail">$data</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The data rows.</td>
        <td><a href="yii-test-baseactivefixture.html">yii\test\BaseActiveFixture</a></td>
    </tr>
            <tr id="$dataFile">
        <td><a href="yii-elasticsearch-activefixture.html#$dataFile-detail">$dataFile</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>The file path or path alias of the data file that contains the fixture data
to be returned by <a href="yii-elasticsearch-activefixture.html#getData()-detail">getData()</a>.</td>
        <td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a></td>
    </tr>
            <tr id="$db">
        <td><a href="yii-elasticsearch-activefixture.html#$db-detail">$db</a></td>
        <td><a href="yii-elasticsearch-connection.html">yii\elasticsearch\Connection</a>|<a href="http://www.php.net/language.types.string">string</a></td>
        <td>The DB connection object or the application component ID of the DB connection.</td>
        <td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a></td>
    </tr>
            <tr class="inherited" id="$depends">
        <td><a href="yii-test-fixture.html#$depends-detail">$depends</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The fixtures that this fixture depends on.</td>
        <td><a href="yii-test-fixture.html">yii\test\Fixture</a></td>
    </tr>
            <tr id="$index">
        <td><a href="yii-elasticsearch-activefixture.html#$index-detail">$index</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The name of the index that this fixture is about.</td>
        <td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a></td>
    </tr>
            <tr class="inherited" id="$iterator">
        <td><a href="yii-base-arrayaccesstrait.html#$iterator-detail">$iterator</a></td>
        <td><a href="http://www.php.net/class.arrayiterator">ArrayIterator</a></td>
        <td>An iterator for traversing the cookies in the collection.</td>
        <td><a href="yii-base-arrayaccesstrait.html">yii\base\ArrayAccessTrait</a></td>
    </tr>
            <tr class="inherited" id="$modelClass">
        <td><a href="yii-test-baseactivefixture.html#$modelClass-detail">$modelClass</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The AR model class associated with this fixture.</td>
        <td><a href="yii-test-baseactivefixture.html">yii\test\BaseActiveFixture</a></td>
    </tr>
            <tr id="$type">
        <td><a href="yii-elasticsearch-activefixture.html#$type-detail">$type</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The name of the type that this fixture is about.</td>
        <td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a></td>
    </tr>
    </table>
</div>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="__call()">
        <td><a href="yii-base-component.html#__call()-detail">__call()</a></td>
        <td>Calls the named method which is not a class method.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__clone()">
        <td><a href="yii-base-component.html#__clone()-detail">__clone()</a></td>
        <td>This method is called after the object is created by cloning an existing one.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__construct()">
        <td><a href="yii-base-object.html#__construct()-detail">__construct()</a></td>
        <td>Constructor.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__get()">
        <td><a href="yii-base-component.html#__get()-detail">__get()</a></td>
        <td>Returns the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__isset()">
        <td><a href="yii-base-component.html#__isset()-detail">__isset()</a></td>
        <td>Checks if a property is set, i.e. defined and not null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__set()">
        <td><a href="yii-base-component.html#__set()-detail">__set()</a></td>
        <td>Sets the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__unset()">
        <td><a href="yii-base-component.html#__unset()-detail">__unset()</a></td>
        <td>Sets a component property to be null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="afterLoad()">
        <td><a href="yii-test-fixture.html#afterLoad()-detail">afterLoad()</a></td>
        <td>This method is called AFTER all fixture data have been loaded for the current test.</td>
        <td><a href="yii-test-fixture.html">yii\test\Fixture</a></td>
    </tr>
            <tr class="inherited" id="afterUnload()">
        <td><a href="yii-test-fixture.html#afterUnload()-detail">afterUnload()</a></td>
        <td>This method is called AFTER all fixture data have been unloaded for the current test.</td>
        <td><a href="yii-test-fixture.html">yii\test\Fixture</a></td>
    </tr>
            <tr class="inherited" id="attachBehavior()">
        <td><a href="yii-base-component.html#attachBehavior()-detail">attachBehavior()</a></td>
        <td>Attaches a behavior to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="attachBehaviors()">
        <td><a href="yii-base-component.html#attachBehaviors()-detail">attachBehaviors()</a></td>
        <td>Attaches a list of behaviors to the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="beforeLoad()">
        <td><a href="yii-test-fixture.html#beforeLoad()-detail">beforeLoad()</a></td>
        <td>This method is called BEFORE any fixture data is loaded for the current test.</td>
        <td><a href="yii-test-fixture.html">yii\test\Fixture</a></td>
    </tr>
            <tr class="inherited" id="beforeUnload()">
        <td><a href="yii-test-fixture.html#beforeUnload()-detail">beforeUnload()</a></td>
        <td>This method is called BEFORE any fixture data is unloaded for the current test.</td>
        <td><a href="yii-test-fixture.html">yii\test\Fixture</a></td>
    </tr>
            <tr class="inherited" id="behaviors()">
        <td><a href="yii-base-component.html#behaviors()-detail">behaviors()</a></td>
        <td>Returns a list of behaviors that this component should behave as.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canGetProperty()">
        <td><a href="yii-base-component.html#canGetProperty()-detail">canGetProperty()</a></td>
        <td>Returns a value indicating whether a property can be read.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canSetProperty()">
        <td><a href="yii-base-component.html#canSetProperty()-detail">canSetProperty()</a></td>
        <td>Returns a value indicating whether a property can be set.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="className()">
        <td><a href="yii-base-object.html#className()-detail">className()</a></td>
        <td>Returns the fully qualified name of this class.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="count()">
        <td><a href="yii-base-arrayaccesstrait.html#count()-detail">count()</a></td>
        <td>Returns the number of data items.</td>
        <td><a href="yii-base-arrayaccesstrait.html">yii\base\ArrayAccessTrait</a></td>
    </tr>
            <tr class="inherited" id="detachBehavior()">
        <td><a href="yii-base-component.html#detachBehavior()-detail">detachBehavior()</a></td>
        <td>Detaches a behavior from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="detachBehaviors()">
        <td><a href="yii-base-component.html#detachBehaviors()-detail">detachBehaviors()</a></td>
        <td>Detaches all behaviors from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="ensureBehaviors()">
        <td><a href="yii-base-component.html#ensureBehaviors()-detail">ensureBehaviors()</a></td>
        <td>Makes sure that the behaviors declared in <a href="yii-base-component.html#behaviors()-detail">behaviors()</a> are attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getBehavior()">
        <td><a href="yii-base-component.html#getBehavior()-detail">getBehavior()</a></td>
        <td>Returns the named behavior object.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getBehaviors()">
        <td><a href="yii-base-component.html#getBehaviors()-detail">getBehaviors()</a></td>
        <td>Returns all behaviors attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
                <tr class="inherited" id="getIterator()">
        <td><a href="yii-base-arrayaccesstrait.html#getIterator()-detail">getIterator()</a></td>
        <td>Returns an iterator for traversing the data.</td>
        <td><a href="yii-base-arrayaccesstrait.html">yii\base\ArrayAccessTrait</a></td>
    </tr>
            <tr class="inherited" id="getModel()">
        <td><a href="yii-test-baseactivefixture.html#getModel()-detail">getModel()</a></td>
        <td>Returns the AR model by the specified model name.</td>
        <td><a href="yii-test-baseactivefixture.html">yii\test\BaseActiveFixture</a></td>
    </tr>
            <tr class="inherited" id="hasEventHandlers()">
        <td><a href="yii-base-component.html#hasEventHandlers()-detail">hasEventHandlers()</a></td>
        <td>Returns a value indicating whether there is any handler attached to the named event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasMethod()">
        <td><a href="yii-base-component.html#hasMethod()-detail">hasMethod()</a></td>
        <td>Returns a value indicating whether a method is defined.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasProperty()">
        <td><a href="yii-base-component.html#hasProperty()-detail">hasProperty()</a></td>
        <td>Returns a value indicating whether a property is defined for this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="init()">
        <td><a href="yii-elasticsearch-activefixture.html#init()-detail">init()</a></td>
        <td>Initializes the object.</td>
        <td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a></td>
    </tr>
            <tr id="load()">
        <td><a href="yii-elasticsearch-activefixture.html#load()-detail">load()</a></td>
        <td>Loads the fixture.</td>
        <td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a></td>
    </tr>
            <tr class="inherited" id="off()">
        <td><a href="yii-base-component.html#off()-detail">off()</a></td>
        <td>Detaches an existing event handler from this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="offsetExists()">
        <td><a href="yii-base-arrayaccesstrait.html#offsetExists()-detail">offsetExists()</a></td>
        <td>This method is required by the interface <a href="http://www.php.net/class.arrayaccess">ArrayAccess</a>.</td>
        <td><a href="yii-base-arrayaccesstrait.html">yii\base\ArrayAccessTrait</a></td>
    </tr>
            <tr class="inherited" id="offsetGet()">
        <td><a href="yii-base-arrayaccesstrait.html#offsetGet()-detail">offsetGet()</a></td>
        <td>This method is required by the interface <a href="http://www.php.net/class.arrayaccess">ArrayAccess</a>.</td>
        <td><a href="yii-base-arrayaccesstrait.html">yii\base\ArrayAccessTrait</a></td>
    </tr>
            <tr class="inherited" id="offsetSet()">
        <td><a href="yii-base-arrayaccesstrait.html#offsetSet()-detail">offsetSet()</a></td>
        <td>This method is required by the interface <a href="http://www.php.net/class.arrayaccess">ArrayAccess</a>.</td>
        <td><a href="yii-base-arrayaccesstrait.html">yii\base\ArrayAccessTrait</a></td>
    </tr>
            <tr class="inherited" id="offsetUnset()">
        <td><a href="yii-base-arrayaccesstrait.html#offsetUnset()-detail">offsetUnset()</a></td>
        <td>This method is required by the interface <a href="http://www.php.net/class.arrayaccess">ArrayAccess</a>.</td>
        <td><a href="yii-base-arrayaccesstrait.html">yii\base\ArrayAccessTrait</a></td>
    </tr>
            <tr class="inherited" id="on()">
        <td><a href="yii-base-component.html#on()-detail">on()</a></td>
        <td>Attaches an event handler to an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
                <tr class="inherited" id="trigger()">
        <td><a href="yii-base-component.html#trigger()-detail">trigger()</a></td>
        <td>Triggers an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="unload()">
        <td><a href="yii-test-baseactivefixture.html#unload()-detail">unload()</a></td>
        <td>Unloads the fixture.</td>
        <td><a href="yii-test-baseactivefixture.html">yii\test\BaseActiveFixture</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-method">
<h2>Protected Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
                                                                                                    <tr id="getData()">
        <td><a href="yii-elasticsearch-activefixture.html#getData()-detail">getData()</a></td>
        <td>Returns the fixture data.</td>
        <td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a></td>
    </tr>
                                                                <tr id="resetIndex()">
        <td><a href="yii-elasticsearch-activefixture.html#resetIndex()-detail">resetIndex()</a></td>
        <td>Removes all existing data from the specified index and type.</td>
        <td><a href="yii-elasticsearch-activefixture.html">yii\elasticsearch\ActiveFixture</a></td>
    </tr>
            </table>
</div>

<a id="events"></a>

<a id="constants"></a>

<h2>Property Details</h2>

<div class="property-doc">

    <div class="detail-header h3" id="$dataFile-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activefixture.html#$dataFile-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveFixture.php#L57" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php#L57" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $dataFile        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The file path or path alias of the data file that contains the fixture data
to be returned by <a href="yii-elasticsearch-activefixture.html#getData()-detail">getData()</a>. If this is not set, it will default to <code>FixturePath/data/Index/Type.php</code>,
where <code>FixturePath</code> stands for the directory containing this fixture class, <code>Index</code> stands for the elasticsearch <a href="yii-elasticsearch-activefixture.html#$index-detail">$index</a> name
and <code>Type</code> stands for the <a href="yii-elasticsearch-activefixture.html#$type-detail">$type</a> associated with this fixture.
You can set this property to be false to prevent loading any data.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.boolean">boolean</a></span> <a href="yii-elasticsearch-activefixture.html#$dataFile-detail">$dataFile</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$db-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activefixture.html#$db-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveFixture.php#L37" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php#L37" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $db        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The DB connection object or the application component ID of the DB connection.
After the DbFixture object is created, if you want to change this property, you should only assign it
with a DB connection object.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-elasticsearch-connection.html">yii\elasticsearch\Connection</a>|<a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-elasticsearch-activefixture.html#$db-detail">$db</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'elasticsearch'</span></div>


    <div class="detail-header h3" id="$index-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activefixture.html#$index-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveFixture.php#L43" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php#L43" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $index        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The name of the index that this fixture is about. If this property is not set,
the name will be determined via <a href="yii-test-baseactivefixture.html#$modelClass-detail">$modelClass</a>.</p>

        <p>See also <a href="yii-test-baseactivefixture.html#$modelClass-detail">$modelClass</a>.</p>    </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-elasticsearch-activefixture.html#$index-detail">$index</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$type-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activefixture.html#$type-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveFixture.php#L49" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php#L49" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $type        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The name of the type that this fixture is about. If this property is not set,
the name will be determined via <a href="yii-test-baseactivefixture.html#$modelClass-detail">$modelClass</a>.</p>

        <p>See also <a href="yii-test-baseactivefixture.html#$modelClass-detail">$modelClass</a>.</p>    </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-elasticsearch-activefixture.html#$type-detail">$type</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>

</div>
<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="getData()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activefixture.html#getData()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveFixture.php#L135" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php#L135" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getData()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns the fixture data.</strong></p>

        <p>The default implementation will try to return the fixture data by including the external file specified by <a href="yii-elasticsearch-activefixture.html#$dataFile-detail">$dataFile</a>.
The file should return an array of data rows (column name =&gt; column value), each corresponding to a row in the index.</p>
<p>If the data file does not exist, an empty array will be returned.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-elasticsearch-activefixture.html#getData()-detail">getData</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The data rows to be inserted into the database index.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="init()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activefixture.html#init()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveFixture.php#L63" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php#L63" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        init()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Initializes the object.</strong></p>

        <p>This method is invoked at the end of the constructor after the object is initialized with the
given configuration.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-elasticsearch-activefixture.html#init()-detail">init</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="load()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activefixture.html#load()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveFixture.php#L88" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php#L88" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        load()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Loads the fixture.</strong></p>

        <p>The default implementation will first clean up the index by calling <a href="yii-elasticsearch-activefixture.html#resetIndex()-detail">resetIndex()</a>.
It will then populate the index with the data returned by <a href="yii-elasticsearch-activefixture.html#getData()-detail">getData()</a>.</p>
<p>If you override this method, you should consider calling the parent implementation
so that the data returned by <a href="yii-elasticsearch-activefixture.html#getData()-detail">getData()</a> can be populated into the index.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-elasticsearch-activefixture.html#load()-detail">load</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="resetIndex()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activefixture.html#resetIndex()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveFixture.php#L150" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php#L150" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        resetIndex()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Removes all existing data from the specified index and type.</strong></p>

        <p>This method is called before populating fixture data into the index associated with this fixture.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type">void</span> <strong><a href="yii-elasticsearch-activefixture.html#resetIndex()-detail">resetIndex</a></strong> ( )</td></tr>
            </table>

<!--	-->
</div>
        </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:55 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
